Add a rep to a shipment

SecurityAuthToken

Request

path Parameters

shipmentId

required

string <uuid>

The id of the shipment

Request Body schema: application/json
required

role	integer Id of the role
user	string <uuid> Id of the user

Responses

201

Successfully added rep to shipment

Response Schema: application/json

id	string or null <uuid>
	object (ShipmentRepRole) Role a ShipmentRep has on a Shipment
	object (User)

default

Default error response

post/shipments/{shipmentId}/reps/

Request samples

application/json

{"role": 0,
"user": "76f62a58-5404-486d-9afc-07bded328704"
}

Response samples

201
default

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"role": {"id": 0,
"name": "string"
},
"user": {"avatar": "string",
"company_id": "b2e6a1c3-1a5e-44ae-a8fd-81f76fd715cf",
"completed_onboarding": true,
"created_at": "2019-08-24T14:15:22Z",
"custom_data": {"property1": null,
"property2": null
},
"default_shipment_tags": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"email": "string",
"first_name": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"is_active": true,
"is_quoting_limited_user": true,
"last_login": "2019-08-24T14:15:22Z",
"last_name": "string",
"password": "string",
"permissions": ["string"
],
"phone_number": "string",
"subscribed_to_loadboard": true,
"timezone": "string",
"updated_at": "2019-08-24T14:15:22Z",
"verified_email": true
}
}

Add a rep to a shipment

path Parameters

Request Body schema: application/jsonrequired

Response Schema: application/json

Request Body schema: application/json
required